//============================================================================================
/**
 * @file	zukan_param.h
 * @brief	金銀図鑑画面 外部保持パラメータ関連
 * @author	Hiroyuki Nakamura
 * @date	08.09.02
 */
//============================================================================================
#ifndef	ZUKAN_PARAM_H
#define	ZUKAN_PARAM_H


//============================================================================================
//	定数定義
//============================================================================================

// 図鑑モード
enum {
	ZKN2_MODE_JOHTO = 0,	// ジョウト図鑑
	ZKN2_MODE_ZENKOKU,		// 全国図鑑
	ZKN2_MODE_NAZO			// 不明（初めて開いたときなど）
};

// 外部保持パラメータ
typedef struct _ZUKAN_PARAM ZUKAN_PARAM;


//============================================================================================
//	プロトタイプ宣言
//============================================================================================

//--------------------------------------------------------------------------------------------
/**
 * 図鑑画面外部保持パラメータワーク作成
 *
 * @param	heapID	ヒープＩＤ
 *
 * @return	外部保持パラメータワーク
 */
//--------------------------------------------------------------------------------------------
extern ZUKAN_PARAM * ZUKANPARAM_Alloc( u32 heapID );

//--------------------------------------------------------------------------------------------
/**
 * 図鑑画面外部保持パラメータワーク削除
 *
 * @param	prm		外部保持パラメータワーク
 *
 * @return	none
 */
//--------------------------------------------------------------------------------------------
extern void ZUKANPARAM_Exit( ZUKAN_PARAM * prm );

//--------------------------------------------------------------------------------------------
/**
 * 図鑑画面のリスト位置、図鑑モードをセット
 *
 * @param	prm		外部保持パラメータワーク
 * @param	mons	リスト位置
 * @param	mode	図鑑モード
 *
 * @return	none
 */
//--------------------------------------------------------------------------------------------
extern void ZUKANPARAM_Set( ZUKAN_PARAM * prm, u32 mons, u32 mode );

//--------------------------------------------------------------------------------------------
/**
 * 図鑑モード取得
 *
 * @param	prm		外部保持パラメータワーク
 *
 * @return	none
 */
//--------------------------------------------------------------------------------------------
extern u32 ZUKANPARAM_ModeGet( ZUKAN_PARAM * prm );

//--------------------------------------------------------------------------------------------
/**
 * リスト位置取得
 *
 * @param	prm		外部保持パラメータワーク
 *
 * @return	リスト位置
 */
//--------------------------------------------------------------------------------------------
extern u32 ZUKANPARAM_ListPosGet( ZUKAN_PARAM * prm );


#endif	// ZUKAN_PARAM_H